home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dgegv.z / dgegv
Encoding:
Text File  |  2002-10-03  |  11.0 KB  |  265 lines
  1.  
  2.  
  3.  
  4. DDDDGGGGEEEEGGGGVVVV((((3333SSSS))))                                                            DDDDGGGGEEEEGGGGVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DGEGV - routine is deprecated and has been replaced by routine DGGEV
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      SUBROUTINE DGEGV( JOBVL, JOBVR, N, A, LDA, B, LDB, ALPHAR, ALPHAI, BETA,
  13.                        VL, LDVL, VR, LDVR, WORK, LWORK, INFO )
  14.  
  15.          CHARACTER     JOBVL, JOBVR
  16.  
  17.          INTEGER       INFO, LDA, LDB, LDVL, LDVR, LWORK, N
  18.  
  19.          DOUBLE        PRECISION A( LDA, * ), ALPHAI( * ), ALPHAR( * ), B(
  20.                        LDB, * ), BETA( * ), VL( LDVL, * ), VR( LDVR, * ),
  21.                        WORK( * )
  22.  
  23. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  24.      These routines are part of the SCSL Scientific Library and can be loaded
  25.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  26.      directs the linker to use the multi-processor version of the library.
  27.  
  28.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  29.      4 bytes (32 bits). Another version of SCSL is available in which integers
  30.      are 8 bytes (64 bits).  This version allows the user access to larger
  31.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  32.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  33.      only one of the two versions; 4-byte integer and 8-byte integer library
  34.      calls cannot be mixed.
  35.  
  36. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  37.      This routine is deprecated and has been replaced by routine DGGEV. DGEGV
  38.      computes for a pair of n-by-n real nonsymmetric matrices A and B, the
  39.      generalized eigenvalues (alphar +/- alphai*i, beta), and optionally, the
  40.      left and/or right generalized eigenvectors (VL and VR).
  41.  
  42.      A generalized eigenvalue for a pair of matrices (A,B) is, roughly
  43.      speaking, a scalar w or a ratio  alpha/beta = w, such that  A - w*B is
  44.      singular.  It is usually represented as the pair (alpha,beta), as there
  45.      is a reasonable interpretation for beta=0, and even for both being zero.
  46.      A good beginning reference is the book, "Matrix Computations", by G.
  47.      Golub & C. van Loan (Johns Hopkins U. Press)
  48.  
  49.      A right generalized eigenvector corresponding to a generalized eigenvalue
  50.      w  for a pair of matrices (A,B) is a vector  r  such that  (A - w B) r =
  51.      0 .  A left generalized eigenvector is a vector l such that l**H * (A - w
  52.      B) = 0, where l**H is the
  53.      conjugate-transpose of l.
  54.  
  55.      Note: this routine performs "full balancing" on A and B -- see "Further
  56.      Details", below.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDGGGGEEEEGGGGVVVV((((3333SSSS))))                                                            DDDDGGGGEEEEGGGGVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  75.      JOBVL   (input) CHARACTER*1
  76.              = 'N':  do not compute the left generalized eigenvectors;
  77.              = 'V':  compute the left generalized eigenvectors.
  78.  
  79.      JOBVR   (input) CHARACTER*1
  80.              = 'N':  do not compute the right generalized eigenvectors;
  81.              = 'V':  compute the right generalized eigenvectors.
  82.  
  83.      N       (input) INTEGER
  84.              The order of the matrices A, B, VL, and VR.  N >= 0.
  85.  
  86.      A       (input/output) DOUBLE PRECISION array, dimension (LDA, N)
  87.              On entry, the first of the pair of matrices whose generalized
  88.              eigenvalues and (optionally) generalized eigenvectors are to be
  89.              computed.  On exit, the contents will have been destroyed.  (For
  90.              a description of the contents of A on exit, see "Further
  91.              Details", below.)
  92.  
  93.      LDA     (input) INTEGER
  94.              The leading dimension of A.  LDA >= max(1,N).
  95.  
  96.      B       (input/output) DOUBLE PRECISION array, dimension (LDB, N)
  97.              On entry, the second of the pair of matrices whose generalized
  98.              eigenvalues and (optionally) generalized eigenvectors are to be
  99.              computed.  On exit, the contents will have been destroyed.  (For
  100.              a description of the contents of B on exit, see "Further
  101.              Details", below.)
  102.  
  103.      LDB     (input) INTEGER
  104.              The leading dimension of B.  LDB >= max(1,N).
  105.  
  106.      ALPHAR  (output) DOUBLE PRECISION array, dimension (N)
  107.              ALPHAI  (output) DOUBLE PRECISION array, dimension (N) BETA
  108.              (output) DOUBLE PRECISION array, dimension (N) On exit,
  109.              (ALPHAR(j) + ALPHAI(j)*i)/BETA(j), j=1,...,N, will be the
  110.              generalized eigenvalues.  If ALPHAI(j) is zero, then the j-th
  111.              eigenvalue is real; if positive, then the j-th and (j+1)-st
  112.              eigenvalues are a complex conjugate pair, with ALPHAI(j+1)
  113.              negative.
  114.  
  115.              Note: the quotients ALPHAR(j)/BETA(j) and ALPHAI(j)/BETA(j) may
  116.              easily over- or underflow, and BETA(j) may even be zero.  Thus,
  117.              the user should avoid naively computing the ratio alpha/beta.
  118.              However, ALPHAR and ALPHAI will be always less than and usually
  119.              comparable with norm(A) in magnitude, and BETA always less than
  120.              and usually comparable with norm(B).
  121.  
  122.      VL      (output) DOUBLE PRECISION array, dimension (LDVL,N)
  123.              If JOBVL = 'V', the left generalized eigenvectors.  (See
  124.              "Purpose", above.)  Real eigenvectors take one column, complex
  125.              take two columns, the first for the real part and the second for
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDGGGGEEEEGGGGVVVV((((3333SSSS))))                                                            DDDDGGGGEEEEGGGGVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              the imaginary part.  Complex eigenvectors correspond to an
  141.              eigenvalue with positive imaginary part.  Each eigenvector will
  142.              be scaled so the largest component will have abs(real part) +
  143.              abs(imag. part) = 1, *except* that for eigenvalues with
  144.              alpha=beta=0, a zero vector will be returned as the corresponding
  145.              eigenvector.  Not referenced if JOBVL = 'N'.
  146.  
  147.      LDVL    (input) INTEGER
  148.              The leading dimension of the matrix VL. LDVL >= 1, and if JOBVL =
  149.              'V', LDVL >= N.
  150.  
  151.      VR      (output) DOUBLE PRECISION array, dimension (LDVR,N)
  152.              If JOBVR = 'V', the right generalized eigenvectors.  (See
  153.              "Purpose", above.)  Real eigenvectors take one column, complex
  154.              take two columns, the first for the real part and the second for
  155.              the imaginary part.  Complex eigenvectors correspond to an
  156.              eigenvalue with positive imaginary part.  Each eigenvector will
  157.              be scaled so the largest component will have abs(real part) +
  158.              abs(imag. part) = 1, *except* that for eigenvalues with
  159.              alpha=beta=0, a zero vector will be returned as the corresponding
  160.              eigenvector.  Not referenced if JOBVR = 'N'.
  161.  
  162.      LDVR    (input) INTEGER
  163.              The leading dimension of the matrix VR. LDVR >= 1, and if JOBVR =
  164.              'V', LDVR >= N.
  165.  
  166.      WORK    (workspace/output) DOUBLE PRECISION array, dimension (LWORK)
  167.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  168.  
  169.      LWORK   (input) INTEGER
  170.              The dimension of the array WORK.  LWORK >= max(1,8*N).  For good
  171.              performance, LWORK must generally be larger.  To compute the
  172.              optimal value of LWORK, call ILAENV to get blocksizes (for
  173.              DGEQRF, DORMQR, and DORGQR.)  Then compute:  NB  -- MAX of the
  174.              blocksizes for DGEQRF, DORMQR, and DORGQR; The optimal LWORK is:
  175.              2*N + MAX( 6*N, N*(NB+1) ).
  176.  
  177.              If LWORK = -1, then a workspace query is assumed; the routine
  178.              only calculates the optimal size of the WORK array, returns this
  179.              value as the first entry of the WORK array, and no error message
  180.              related to LWORK is issued by XERBLA.
  181.  
  182.      INFO    (output) INTEGER
  183.              = 0:  successful exit
  184.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  185.              = 1,...,N:  The QZ iteration failed.  No eigenvectors have been
  186.              calculated, but ALPHAR(j), ALPHAI(j), and BETA(j) should be
  187.              correct for j=INFO+1,...,N.  > N:  errors that usually indicate
  188.              LAPACK problems:
  189.              =N+1: error return from DGGBAL
  190.              =N+2: error return from DGEQRF
  191.              =N+3: error return from DORMQR
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. DDDDGGGGEEEEGGGGVVVV((((3333SSSS))))                                                            DDDDGGGGEEEEGGGGVVVV((((3333SSSS))))
  203.  
  204.  
  205.  
  206.              =N+4: error return from DORGQR
  207.              =N+5: error return from DGGHRD
  208.              =N+6: error return from DHGEQZ (other than failed iteration)
  209.              =N+7: error return from DTGEVC
  210.              =N+8: error return from DGGBAK (computing VL)
  211.              =N+9: error return from DGGBAK (computing VR)
  212.              =N+10: error return from DLASCL (various calls)
  213.  
  214. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  215.      Balancing
  216.      ---------
  217.  
  218.      This driver calls DGGBAL to both permute and scale rows and columns of A
  219.      and B.  The permutations PL and PR are chosen so that PL*A*PR and PL*B*R
  220.      will be upper triangular except for the diagonal blocks A(i:j,i:j) and
  221.      B(i:j,i:j), with i and j as close together as possible.  The diagonal
  222.      scaling matrices DL and DR are chosen so that the pair  DL*PL*A*PR*DR,
  223.      DL*PL*B*PR*DR have elements close to one (except for the elements that
  224.      start out zero.)
  225.  
  226.      After the eigenvalues and eigenvectors of the balanced matrices have been
  227.      computed, DGGBAK transforms the eigenvectors back to what they would have
  228.      been (in perfect arithmetic) if they had not been balanced.
  229.  
  230.      Contents of A and B on Exit
  231.      -------- -- - --- - -- ----
  232.  
  233.      If any eigenvectors are computed (either JOBVL='V' or JOBVR='V' or both),
  234.      then on exit the arrays A and B will contain the real Schur form[*] of
  235.      the "balanced" versions of A and B.  If no eigenvectors are computed,
  236.      then only the diagonal blocks will be correct.
  237.  
  238.      [*] See DHGEQZ, DGEGS, or read the book "Matrix Computations",
  239.          by Golub & van Loan, pub. by Johns Hopkins U. Press.
  240.  
  241.  
  242. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  243.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  244.  
  245.      This man page is available only online.
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.